Skip to main content

ACH OUTBOUND

The ACH OUT API enables to process outgoing Automated Clearing House (ACH) transactions.

Method: POST​

{{localCEUrl}}/analytics/rest/eventApi/event

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

InstructionIdentification

Mandatory

String

Unique identifier of the payment instruction

Example – "f9a820da-7bcd-4941-b85c-201169ccf41a"

EndToEndIdentification

Optional

String

Unique identifier to track the transaction any time during the process

Example – "31fe4401-d804-441e-b67a-44016b99b08f"

BeneficiaryInformation

Optional

String

Information to the beneficiary

Example – "Client Refund"

Reason

Optional

String

Reason or purpose given for the transaction

Example – "Loan Repayment"

Channel

Optional

String

Channel through which the transaction happens

Example – "ACH"

TransactionType

Optional

String

Type of transaction

Example – "ACH_CREDIT"

TransactionCode

Optional

String

Specific code for the transaction type

Example – "ACH_CREDIT_CCD"

Source

Optional

String

Name of the source system from where the payment request is initiated

Example – "LEDGER"

TransactionAmount

Mandatory

Object

Amount

Mandatory

String

Amount of the transaction

Example – "251.00"

Currency

Mandatory

String

Currency type of the transaction amount

Example – "USD"

Creditor

Required

Object

CustomerType

Optional

String

Customer type of the creditor (receiver), which can possibly be the ‘Account Holder', ‘Non-account Holder', ‘Account Holder Business' or ‘TSP'

Example – "EXTERNAL"

UserType

Optional

String

Type of the user based on user-role, which can be ‘Individual' or ‘Legal Rep'

Example – "UNKNOWN"

CustomerNumber

Optional

String

Unique ID provided for the debtor as a customer

Example – "1834177889-021000018"

InstitutionNumber

Optional

String

Unique ID that identifies the financial institution

Example – "123456789012345"

Name

Required

String

Customer name of the creditor

Example – "Jhon Doe"

NameInFile

Optional

String

Name of the creditor given in the payment instruction

Example – "Jhon D"

CreditorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the creditor

Example – "-"

AccountType

Optional

String

Type of the creditor's account

Example – "CHECKING"

AccountName

Optional

String

Creditor's account name

Example – "GENERAL ACCOUNT"

Institution

Optional

Object

Identification

Optional

String

Identification code of the creditor account financial institution, which is possibly the routing number

Example – "021000018"

IdentificationType

Optional

String

Identification type of the creditor account financial institution

Example – "ABA"

Name

Optional

String

Name of the creditor account financial institution

Example – "Bank Of New York"

Debtor

Required

Object

CustomerType

Optional

String

Customer type of the debtor (sender), which can possibly be the ‘Account Holder', ‘Account Holder Business' or ‘TSP'

Example – "ACCOUNT_HOLDER_BUSINESS"

UserType

Optional

String

User type of the debtor

Example – "INDIVIDUAL"

Identification

Optional

String

Individual ID of the debtor

Example – "994140005"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "SSN"

CustomerNumber

Optional

String

Unique ID provided for the debtor as a customer

Example – "169728101301663"

Name

Required

String

Customer name of the debtor

Example – "Donnell Smith"

DebtorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the debtor

Example – "200162780837000"

AccountType

Optional

String

Type of the debtor's account

Example – "CHECKING"

AccountName

Optional

String

Debtor's account name

Example – "Payments Account"

Institution

Optional

Object

Name

Optional

String

Name of the debtor account financial institution

Example – "Union Savings Bank"

Identification

Optional

String

Identification code of the debtor account financial institution, which is possibly the routing number

Example – "011102502"

IdentificationType

Optional

String

Identification type of the debtor account financial institution

Example – "ABA"

DebtorDateOfBirth

Optional

Object

Year

Optional

String

Birth year of the debtor

Example – "1970"

Month

Optional

String

Birth month of the debtor

Example – "11"

Day

Optional

String

Birth year of the debtor

Example – "15"

DebtorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of debtor

Example – "HOUSE"

AddressLine1

Optional

String

Line 1 of debtor address

Example – "3745 SW VENEZULA CUBARD IRANMA"

AddressLine2

Optional

String

Line 2 of debtor address

Example – "Suite C"

City

Optional

String

City name of the debtor address

Example – "Pque Central"

State

Optional

String

State of the debtor address

Example – "Caracas"

ZipCode

Optional

String

Zip code of debtor address location

Example – "66610"

CountryCode

Optional

String

Country code of debtor country

Example – "862"

Nationality

Optional

String

Nationality of the debtor

Example – "Venezuela"

Country

Optional

String

Country of the debtor's location

Example – "Venezuela"

DebtorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the debtor

Example – "lifetime@lifetime.com"

PrimaryPhone

Optional

String

Contact phone number of the debtor

Example – "0017850010002"

FedDetails

Optional

Object

FedReceiver

Optional

Object

Identification

Optional

String

Identification code of the receiver bank of FED

Example – "021000018"

IdentificationType

Optional

String

Identification type of the receiver bank of FED

Example – "ABA"

Name

Optional

String

Name of the receiver bank of FED

Example – "Bank Of New York"

FedSender

Optional

Object

Identification

Optional

String

Identification code of the sender bank of FED

Example – "011102502"

IdentificationType

Optional

String

Identification type of the sender bank of FED

Example – "ABA"

Name

Optional

String

Name of the sender bank of FED

Example – "Union Savings Bank"

Risk

Optional

Object

MachineFingerPrint

Optional

Object


curl --location 'http://localhost:8080/BiReport/rest/eventApi/event' \
--header 'Content-Type: application/json' \
--data-raw '{"InstructionIdentification":"f9a820da-7bcd-4941-b85c-201169ccf41a","EndToEndIdentification":"31fe4401-d804-441e-b67a-44016b99b08f","BeneficiaryInformation":"Client Refund","Reason":"Loan Repayment","Channel":"ACH","TranactionType":"ACH_DEBIT","TranactionCode":"ACH_DEBIT_CCD","Source":"LEDGER","TransactionAmount":{"Amount":"251.00","Currency":"USD"},"Creditor":{"CustomerType":"EXTERNAL","UserType":"UNKNOWN","CustomerNumber":"1834177889-021000018","InstitutionNumber":"123456789012345","Name":"Jhon Doe","NameInFile":"Jhon D"},"CreditorAccount":{"AccountNumber":"-","AccountType":"CHECKING","AccountName":"General Account","Institution":{"Identification":"021000018","IdentificationType":"ABA","Name":"Bank Of New York"}},"Debtor":{"CustomerType":"ACCOUNT_HOLDER_BUSINESS","UserType":"INDIVIDUAL","Identification":"994140005","IdentificationType":"SSN","CustomerNumber":"169728101301663","Name":"Starbucks OT 01"},"DebtorAccount":{"AccountNumber":"200162780837000","AccountType":"CHECKING","AccountName":"Payments Account","Institution":{"Name":"Union Savings Bank","Identification":"011102502","IdentificationType":"ABA"}},"DebtorDateOfBirth":{"Year":"1970","Month":"11","Day":"15"},"DebtorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"3745 SW VENEZULA CUBARD IRANMA","AddressLine2":"Suite C","City":"Topeka","State":"KS","ZipCode":"66610","CountryCode":"840","Nationality":" VENEZUALA ","Country":"VENEZUALA"},"DebtorContact":{"PrimaryEmail":"lifetime@lifetime.com","PrimaryPhone":"0017850010002"},"FedDetails":{"FedReceiver":{"Identification":"021000018","IdentificationType":"ABA","Name":"Bank Of New York"},"FedSender":{"Identification":"011102502","IdentificationType":"ABA","Name":"Union Savings Bank"}},"Risk":{"MachineFingerPrint":{}}}'

Body​


{
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "BeneficiaryInformation": "Client Refund",
  "Reason": "Loan Repayment",
  "Channel": "ACH",
  "TranactionType": "ACH_DEBIT",
  "TranactionCode": "ACH_DEBIT_CCD",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "251.00",
    "Currency": "USD"
  },
  "Creditor": {
    "CustomerType": "EXTERNAL",
    "UserType": "UNKNOWN",
    "CustomerNumber": "1834177889-021000018",
    "InstitutionNumber": "123456789012345",
    "Name": "Jhon Doe",
    "NameInFile": "Jhon D"
  },
  "CreditorAccount": {
    "AccountNumber": "-",
    "AccountType": "CHECKING",
    "AccountName": "General Account",
    "Institution": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    }
  },
  "Debtor": {
    "CustomerType": "ACCOUNT_HOLDER_BUSINESS",
    "UserType": "INDIVIDUAL",
    "Identification": "994140005",
    "IdentificationType": "SSN",
    "CustomerNumber": "169728101301663",
    "Name": "Starbucks OT 01"
  },
  "DebtorAccount": {
    "AccountNumber": "200162780837000",
    "AccountType": "CHECKING",
    "AccountName": "Payments Account",
    "Institution": {
      "Name": "Union Savings Bank",
      "Identification": "011102502",
      "IdentificationType": "ABA"
    }
  },
  "DebtorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "DebtorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
    "AddressLine2": "Suite C",
    "City": "Topeka",
    "State": "KS",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": " VENEZUALA ",
    "Country": "VENEZUALA"
  },
  "DebtorContact": {
    "PrimaryEmail": "lifetime@lifetime.com",
    "PrimaryPhone": "0017850010002"
  },
  "FedDetails": {
    "FedReceiver": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    },
    "FedSender": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    }
  },
  "Risk": {
    "MachineFingerPrint": {}
  }
}

Response: 200​

Payload Parameters
ParameterDescription

id

String

ID of the request

Example – "27d9fcfc-e109-408c-bce0-aff33fffb8e8"

jsonrpc

String

JSON-RPC version used for the API

Example – "2.0"

method

String

API method

Example – "ce.event"

result

Object

resp

String

Type of response

Example – "event"

status

String

Status of the event

Example – "1"

riskScore

Number

Estimated Risk score of the transaction

Example – 1108

signalScore

Number

Signal reliability score of the transaction

Example – 1032

scenarioScore

Number

Score of specific scenarios related to the transaction event

Example – 0

tokenScore

Number

Score of token authentication used in the transaction

Example – 0

categoryScore

Number

Event category score of transaction

Example – 0

ofacConfidentScore

Number

Estimated score of compliance with OFAC regulations

Example – 76

debtorProfileId

String

Unique ID of debtor profile

Example – "2CED9F48EE3B49D97D9263F1AEAB26D8"

creditorProfileId

String

Unique ID of creditor profile

Example – "587D9FA3AC2CAB425ADD3B5E3312289E"

error

Null

Shows information, if any error occurs during transaction

Example – null


{
  "id": "27d9fcfc-e109-408c-bce0-aff33fffb8e8",
  "jsonrpc": "2.0",
  "method": "ce.event",
  "result": {
    "resp": "event",
    "status": "1",
    "riskScore": 1108,
    "signalScore": 1032,
    "scenarioScore": 0,
    "tokenScore": 0,
    "categoryScore": 0,
    "ofacConfidentScore": 76,
    "debtorProfileId": "2CED9F48EE3B49D97D9263F1AEAB26D8",
    "creditorProfile": "587D9FA3AC2CAB425ADD3B5E3312289E"
  },
  "error": null
}